get

get

Path Parameters

dealerUuid string required

dealerUuid

application/json

Request Body required

filter

apptEndDateTime string
apptStartDateTime string
apptUuids string[]
dealerDepartmentUuidList string[]
prospectEndDateTime string
prospectStartDateTime string
prospectUuids string[]
requesterUserUuid string

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

error object
code string
description string
metadata object
property name* string
prospectProximity object[]
Array [
apptDateTime string
apptUuid string
dealerUuid string
destinationLat double
destinationLng double
originLat double
originLng double
originType string
Possible values: [DEALER, APPOINTMENT]
prospectContactDate string
prospectUuid string
proximity object
distanceInMeters int64
status string
timeInSeconds int64
uuid string
]
statusCode int32
warnings object[]
Array [
code string
description string
]

{
  "error": {
    "code": "string",
    "description": "string",
    "metadata": {}
  },
  "prospectProximity": [
    {
      "apptDateTime": "string",
      "apptUuid": "string",
      "dealerUuid": "string",
      "destinationLat": 0,
      "destinationLng": 0,
      "originLat": 0,
      "originLng": 0,
      "originType": "DEALER",
      "prospectContactDate": "string",
      "prospectUuid": "string",
      "proximity": {
        "distanceInMeters": 0,
        "status": "string",
        "timeInSeconds": 0
      },
      "uuid": "string"
    }
  ],
  "statusCode": 0,
  "warnings": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /proximity/dealer/:dealerUuid/list

Request

Base URL

//api.mykaarma.com/mobile-service

dealerUuid — path required

Body required

{
  "apptEndDateTime": "string",
  "apptStartDateTime": "string",
  "apptUuids": [
    "string"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "prospectEndDateTime": "string",
  "prospectStartDateTime": "string",
  "prospectUuids": [
    "string"
  ],
  "requesterUserUuid": "string"
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/mobile-service/proximity/dealer/:dealerUuid/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "apptEndDateTime": "string",
  "apptStartDateTime": "string",
  "apptUuids": [
    "string"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "prospectEndDateTime": "string",
  "prospectStartDateTime": "string",
  "prospectUuids": [
    "string"
  ],
  "requesterUserUuid": "string"
}'

python / requests

curl -L -X POST '//api.mykaarma.com/mobile-service/proximity/dealer/:dealerUuid/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "apptEndDateTime": "string",
  "apptStartDateTime": "string",
  "apptUuids": [
    "string"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "prospectEndDateTime": "string",
  "prospectStartDateTime": "string",
  "prospectUuids": [
    "string"
  ],
  "requesterUserUuid": "string"
}'

go / native

curl -L -X POST '//api.mykaarma.com/mobile-service/proximity/dealer/:dealerUuid/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "apptEndDateTime": "string",
  "apptStartDateTime": "string",
  "apptUuids": [
    "string"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "prospectEndDateTime": "string",
  "prospectStartDateTime": "string",
  "prospectUuids": [
    "string"
  ],
  "requesterUserUuid": "string"
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/mobile-service/proximity/dealer/:dealerUuid/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "apptEndDateTime": "string",
  "apptStartDateTime": "string",
  "apptUuids": [
    "string"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "prospectEndDateTime": "string",
  "prospectStartDateTime": "string",
  "prospectUuids": [
    "string"
  ],
  "requesterUserUuid": "string"
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/mobile-service/proximity/dealer/:dealerUuid/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "apptEndDateTime": "string",
  "apptStartDateTime": "string",
  "apptUuids": [
    "string"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "prospectEndDateTime": "string",
  "prospectStartDateTime": "string",
  "prospectUuids": [
    "string"
  ],
  "requesterUserUuid": "string"
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/mobile-service/proximity/dealer/:dealerUuid/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "apptEndDateTime": "string",
  "apptStartDateTime": "string",
  "apptUuids": [
    "string"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "prospectEndDateTime": "string",
  "prospectStartDateTime": "string",
  "prospectUuids": [
    "string"
  ],
  "requesterUserUuid": "string"
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/mobile-service/proximity/dealer/:dealerUuid/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "apptEndDateTime": "string",
  "apptStartDateTime": "string",
  "apptUuids": [
    "string"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "prospectEndDateTime": "string",
  "prospectStartDateTime": "string",
  "prospectUuids": [
    "string"
  ],
  "requesterUserUuid": "string"
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/mobile-service/proximity/dealer/:dealerUuid/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "apptEndDateTime": "string",
  "apptStartDateTime": "string",
  "apptUuids": [
    "string"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "prospectEndDateTime": "string",
  "prospectStartDateTime": "string",
  "prospectUuids": [
    "string"
  ],
  "requesterUserUuid": "string"
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/mobile-service/proximity/dealer/:dealerUuid/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "apptEndDateTime": "string",
  "apptStartDateTime": "string",
  "apptUuids": [
    "string"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "prospectEndDateTime": "string",
  "prospectStartDateTime": "string",
  "prospectUuids": [
    "string"
  ],
  "requesterUserUuid": "string"
}'